// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using System.Collections.Generic;

namespace Taimila.Entify
{
	/// <summary>
	/// Persistent store provides mechanism to save entities to the disk
	/// in some format. Entites might be saved for example as binaryfiles, 
	/// XML or into database.
	/// </summary>
	internal interface IPersistentStore
	{		
		/// <summary>
		/// Adds entities to persistent store.
		/// </summary>
		/// <param name="entities">
		/// Entities to be added. 
		/// </param>
		void Add<T>(T[] entities) where T : Entity;
		
		/// <summary>
		/// Remove existing persistent entities from store.
		/// </summary>
		/// <param name="entities">
		/// Entities to be removed
		/// </param>
		void Remove<T>(T[] entities) where T : Entity;
		
		/// <summary>
		/// Update existing entities in the store.
		/// </summary>
		/// <param name="entities">
		/// Entities to be updated. 
		/// </param>
		void Update<T>(T[] entities) where T : Entity;
		
		/// <summary>
		/// Get number of entities of given type in persistent store.
		/// </summary>
		/// <returns>
		/// Entity count of given type. <see cref="System.Int32"/>
		/// </returns>
		long GetEntityCount<T>() where T : Entity;
		
		/// <summary>
		/// Get entities with entity request.
		/// </summary>
		/// <param name="entityRequest">
		/// Entity request. <see cref="EntityRequest<T>"/>
		/// </param>
		/// <returns>
		/// All entities matching the request. 
		/// </returns>
		T[] Get<T>(EntityRequest<T> entityRequest) where T : Entity;
	}
}
